Metadata-Version: 2.4
Name: saay-api
Version: 1.0.0
Summary: Saay API — A local-first API client platform
Author: Thierno Sadou BARRY
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic>=2.0
Requires-Dist: sqlalchemy[asyncio]>=2.0
Requires-Dist: aiosqlite>=0.19
Requires-Dist: httpx[http2]>=0.27
Requires-Dist: rich>=13.0
Requires-Dist: pydantic-settings>=2.0
Requires-Dist: click>=8.0
Requires-Dist: cryptography<51,>=50.0.1
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
Requires-Dist: pytest-httpx>=0.30; extra == "dev"
Requires-Dist: ruff>=0.4; extra == "dev"
Requires-Dist: mypy>=1.10; extra == "dev"
Provides-Extra: gui
Requires-Dist: pyside6>=6.6; extra == "gui"
Requires-Dist: qasync>=0.27; extra == "gui"
Dynamic: license-file

# SAAY API 1.0.0 — tester candidate

Local API testing client with CLI, optional PySide6 GUI, SQLite workspaces,
variables, HTTP authentication and trusted Python/JavaScript scripts.
This is a desktop/CLI client; it does not expose an HTTP service for VM 102.

Use a separate Python 3.11/3.12 virtual environment. SAAY AI also installs a
package named `saay`, so installing both in one environment is unsupported.

```sh
python3 -m venv .venv
. .venv/bin/activate
pip install -e ".[dev,gui]"
saay-cli --help
saay-gui
```

Node.js is required for JavaScript scripts. Python scripts run in a disposable
worker with a timeout; restrictions and Node's VM are not security boundaries.
Only run scripts you trust. Secrets are stored as plaintext in
`~/.saay/saay.db`; use test credentials. GUI edits affect the next Send action,
while persistent request creation/management currently uses the CLI.
The environment selector applies to the current request. File/multipart bodies
are supported by the engine/CLI; the GUI body tab edits raw text or JSON.

```sh
saay-cli workspace create "Tester"
saay-cli workspace list
saay-cli collection create <workspace_id> "Smoke tests"
saay-cli request create <collection_id> "Health" --method GET --url http://127.0.0.1:9846/health
saay-cli run <request_id>
python -m pytest -q
ruff check saay tests
mypy saay
```

Test Send after editing the URL, method, headers and JSON; confirm the displayed
response matches the edited request. Test variable selection, failed connections,
script assertions and worker timeouts. Automated GUI checks run offscreen.

## V1 release checks and verified downloads

Explicit update checks and verified downloads are implemented. Remote requests use
the authenticated gateway and a provisioned Ed25519 release-key pin. No automatic
installation or background telemetry is enabled. See the workspace
[update protocol](../../infra/docs/SAAY-V1-Update-Protocol.md) for configuration,
commands and verification; the [tester guide](../../TESTING-V1.md) records scope.
